/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

package org.apache.airavata.metcat.parser;

import java.util.List;
import java.util.Map;

import org.apache.airavata.metcat.db.workflowmodel.WorkflowProgress;
import org.w3c.dom.Document;

public abstract class EventNotificationParser {
    
	protected final String EXPERIMENT_IDENTICATION = "experimentID";
	protected final String WORKFLOW_IDENTIFICATION = "workflowID";
	protected final String TIMESTAMP_IDENTIFCATION = "timestamp";
	protected final String SERVICE_IDENTIFICATION = "serviceID";
	
	// key is namespace and List is the list of attributes which will be indices.
	protected Map<String, List<IndexAttribute>> metadataIndices = null;
	protected XMLNodeCapturable xmlcapture = new DOMNodeParser();
	
	protected WorkflowProgress wfProgress = new WorkflowProgress();
	
	protected Map<String, String> parseEventNotification(Document xmldoc) throws Exception {
		if (this.metadataIndices == null) {
			// seem to be not initialized the class object.
			return null;
		}
		
		return xmlcapture.parseXMLNodes(xmldoc, metadataIndices);
	}
	
	public abstract void refreshCache();
	
	public abstract Map<String, String> filterAndStore(Document source) throws Exception;
	
	protected void markWorkflowProgress(String workflowID, String timestamp) {
		this.markWorkflowProgress(null, workflowID, timestamp);
	}
	
	protected void markWorkflowProgress(String experimentID, String workflowID, String timestamp) {
		if (workflowID == null && experimentID == null) return;
		if (workflowID == null) {
			wfProgress.setWorkflowData(experimentID, timestamp, this.getEventName());
		} else {
			wfProgress.setWorkflowData(workflowID, timestamp, this.getEventName());
		}
	}
	
	protected abstract String getEventName();
	
}
